Add Raises Section to cBOSS docstring #1766#2782
Add Raises Section to cBOSS docstring #1766#2782hiteshkarvil wants to merge 5 commits intoaeon-toolkit:mainfrom
Conversation
Thank you for contributing to
|
|
hi, thanks for that, but some of the lines need to be broken. If you install pre-commit you can pick this up on commit aeon/classification/dictionary_based/_cboss.py:209:89: E501 line too long (99 > 88 characters) |
|
This PR appears to be abandoned. If you want to continue working on it please post here/reopen. Closing for now. |
Reference Issues/PRs
Fixes #1766.
What does this implement/fix? Explain your changes.
This PR adds a Raises section to the docstring of the ContractableBOSS classifier’s _fit method in aeon/classification/dictionary_based/_cboss.py, addressing issue #1766. I documented the following exceptions:
TypeError: Raised when the input X is not a numpy.ndarray, pandas.DataFrame, or a list of numpy.ndarray/pandas.DataFrame.
ValueError: Raised when min_window is greater than the computed max_window, which can occur if the series is too short or min_window is set too large in the constructor.
Does your contribution introduce a new dependency? If yes, which one?
No, this contribution does not introduce any new dependencies.